FieldName
|
Name of the field or attribute
|
String
|
FieldType
|
Type of data allowed in the field. Additional fields are associated with types to provide additional information. Valid values:
- Account
- Checkbox
- Company
- Contact
- Currency
- Date
- Datetime
- Dropdown
- Employee
- Equipment
- Firm
- LABCD
- Memo
- Mkt
- Name
- Numeric
- Opportunity
- Org
- Phone
- ProjectPlan
- RecordID
- Role
- String
- TextLibrary
- UDIC
- Unit
- UnitTable
- Uppercase
- Vendor
- WBS1
- WBS2
- WBS3
- XML
|
String
|
Caption
|
Text label that shows on the UI
|
String
|
MaxLength
|
User defined length of the attribute
|
Number
|
DefaultValue
|
If not provided, a blank value is assigned. Upon insert, the value can be replaced with a blank represented by " ".
|
String
|
Hidden
|
If true, the value is hidden from the user in the application based on roles and permissions; otherwise, the value is shown to all roles.
|
Boolean
|
Required
|
Whether creating or updating an object, if true, the call requires providing this value; otherwise, this field is optional.
|
Boolean
|
Updateable
|
If true, the role the call is authenticated with can update the field; otherwise, the field cannot be updated by the role.
|
Boolean
|
Decimals
|
When the field type is currency or numeric, this field defines how many decimal places are allowed to the right of the decimal point for the numeric column.
|
Number
|
MinValue
|
When the field type is numeric, this value is the minimum threshold that the field will accept.
|
Number
|
CurrencyType
|
If the instance is multi-currency, this field identifies which currency type is used for the field. The value can be null. Example: The type can be specified as "projectCurrency" or "record" when CustomField is set to true.
|
String
|
CustomField
|
If true, the user can add custom fields; otherwise, custom fields cannot be added. All fields that are custom fields have the prefix "cust".
|
Boolean
|
Codetable
|
If the field type is a dropdown, this field is used to provide the codetable used to populate the dropdown. Valid values for the codetable are read via GET {{url}}/codeTable/{{codeTable}}.
|
String
|
Codes
|
If the field type is a dropdown, this field is used to provide the hard coded list of values.
|
Array
|
LimitToList
|
When the FieldType is a dropdown and the value is true, limit this field to that dropdown list.
|
Boolean
|